docs: add "Get started with Console" user guide - #712
Open
omid-aignostics wants to merge 2 commits into
Open
Conversation
omid-aignostics
force-pushed
the
docs/get-started-console-guide
branch
from
August 12, 2026 14:44
9b65d09 to
f16146a
Compare
omid-aignostics
changed the title
Adds a guide for the flow where slides are uploaded to the organization's bucket with the Python SDK and analyzed in Console at platform.aignostics.com, which is easier for non-technical users than the Launchpad GUI. Structure follows sign up -> upload your slides -> analyze your slides with Atlas H&E-TME, with five screenshots of Console (create run form, slide selection from the bucket, run parameters, viewer overlays, result download), the 30-day result retention window, and a troubleshooting section. Links the guide from the docs index and the interface table in README. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
omid-aignostics
force-pushed
the
docs/get-started-console-guide
branch
from
August 12, 2026 14:46
f16146a to
c5719f7
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. |
The MCP server is not yet usable for customers, so advertising it in the documentation sends readers to instructions they cannot act on. Excludes get_started_mcp.rst from the Sphinx build, drops it from the "Get started" toctree, and comments out the MCP row in the interface table. The guide and its partial stay in the repository; each change carries a note on how to restore it. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
arne-aignx
reviewed
Aug 13, 2026
| To try the workflow before using your own data, download a public example slide — a TCGA lung adenocarcinoma case from the NCI Image Data Commons. Paste this command and press `Enter`: | ||
|
|
||
| ```bash | ||
| uvx aignostics dataset idc download 1.3.6.1.4.1.5962.99.1.1069745200.1645485340.1637452317744.2.0 data/ |
Collaborator
There was a problem hiding this comment.
Two coments
- The directory needs to exist, otherwise the command fails with
│ Invalid value for 'target': Directory 'data/' does not exist. We should make this explicit likereplace-with-existing-directoryin the guide - These commands are on the chopping board, when we slim down Python SDK. I'll invite to a quick meeting to decide what we need to keep. We did this without product input a while back, but we should repeat that with you in the room
|
|
||
| ### 3. Prepare your slides for upload | ||
|
|
||
| Collect the slides you want to analyze in a single folder on your computer — for example a folder called `my-slides`. Subfolders are fine; they are preserved during upload. |
Collaborator
There was a problem hiding this comment.
For consistency we should use the same folder name in all commands and explanations my-slides vs. data in Step 4
| uvx aignostics bucket upload ./my-slides | ||
| ``` | ||
|
|
||
| A progress bar appears, and the message `All files uploaded successfully!` tells you the upload is done. |
Collaborator
There was a problem hiding this comment.
No progress bar for me. Only messages
|
|
||
| Open [platform.aignostics.com](https://platform.aignostics.com) and log in. Select **Analyze** → **My Application Runs** in the sidebar, then click **Create run** in the top right. | ||
|
|
||
|  |
Collaborator
There was a problem hiding this comment.
Image links are broken for me, when I view the md file in Github. Is that expected?
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
…ong-running, skip:test:matrix-runner, skip:test:very-long-running]
Adds a guide for the flow where slides are uploaded to the organization's bucket with the Python SDK and analyzed in Console at platform.aignostics.com, which is easier for non-technical users than the Launchpad GUI.
Structure follows sign up -> upload your slides -> analyze your slides with Atlas H&E-TME, with five screenshots of Console (create run form, slide selection from the bucket, run parameters, viewer overlays, result download), the 30-day result retention window, and a troubleshooting section.
Links the guide from the docs index and the interface table in README.